home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 029a / scc.zip / SAMPLE.V1 < prev    next >
Text File  |  1991-09-11  |  10KB  |  238 lines
  1.         The above SCC Log (along with different SCC Log option settings)
  2.      can help generate a "filtered" SCC change control report Log to
  3.      what is important (delete or insert status) and not important
  4.      (blank status) in your file.
  5.         For example you may not want the '-' or '+' (delete or insert)
  6.      Log status characters for such lines containing differences of 
  7.      only "White Space", "Upper/Lower Case" etc.
  8.  
  9.      At any time you may press the
  10.             F1 key for the       help menu.
  11.             F2 key for the QUICK help menu.
  12.  
  13.  
  14.  
  15.  
  16.   START OF EXAMPLES.....
  17.   " Deleted  Lines  "
  18.      Will show what line and line # that was deleted from the Old.
  19.   " Common Lines    "
  20.      Common Line numbers between the Old and New documents. Cursor
  21.      status will show the corresponding Old line #.
  22.  
  23.  
  24.  
  25.  
  26.  
  27.   " Moved  Lines    "
  28.      These are exact matching lines between documents but may have
  29.      different line numbers.
  30.   " Ignore W h i t e Sp "
  31.      All the    text match e xcept for   white space between documents.
  32.   " IGNORE CASE     "
  33.      All The Text Match Except For UPPER/lower Case between documents.
  34.   " MULTI 123 MATCH    "
  35.      All the TEXT match by using Two 2 or more options between the Old
  36.      and New documents. For example if the option "IGNORE CASE" and
  37.      "IGNORE NUMBERS" allowed the 123 lines match  t h e n  this status.
  38.   " Ignore  Numbers "
  39.      654321 All the text match except for numbers between documents.
  40.   Strip End White                    
  41.        If "Strip End White" was selected the following lines will be   
  42.      exactly alike (same length) and would show as "Common Lines".          
  43.        If "Strip End White" was ** NOT ** selected then the lines    
  44.      will be of different lengths.        
  45.   Common lines
  46.      These lines are common between the Old and New documents.
  47.  
  48.   ** Note ** SCC can also track and VIEW any (ASCII TEXT)
  49.      formatted document such as the following.
  50.  
  51.  
  52.  
  53.  
  54. Page 1                         Overview.scc
  55.  
  56.                       Software Change Control (SCC)
  57.  
  58.                              Softtime Systems
  59.                                P.O. Box 2447
  60.                          Lk Ronknnkoma LI. NY 11779
  61.                                 516 981-8386
  62.  
  63.                   Copyright (c) 1990-91 by Walter Erickson
  64.                            All Rights Reserved.
  65.  
  66.  
  67.                       "A small CASE for a big problem"
  68. Page 1
  69.                                  OVERVIEW 
  70.                            Questions "about" SCC
  71.                                What is SCC .
  72.  
  73.   Software Change Control SCC, as the name implies, is one of the most
  74. powerful an cost-effective tool in this energing field of CASE.
  75. SCC features friendly menu-driven interfaces (with automatic context help)
  76. suitable for use by non-technical administrative, as well as for the
  77. sophisticated user.
  78.  
  79.   SCC closely tracks (logs) all software/text changes between two similar
  80. source files, thereby giving a complete (version to version) audit trail.
  81.  
  82.   A SCC generated Log greatly simplifies any user request for the
  83. (identification) of what, when and why changes were made.
  84.  
  85.                             What does CSS do ?
  86.                             ------------------
  87.   When SCC is run the tracking (output) log file will then reflect
  88. (context) what changes have occurred between the two source files,
  89. thus allowing the programmer and/or management to have a clear visual SCC
  90. log of all software and/or text changes.
  91.  
  92.   This feature enables the user to control all enhancements and
  93. documentation of source data at this critical level.
  94.  
  95.                             Why is SCC needed ?
  96.                             -------------------
  97.   All software source files will need changes. In fact, it is a truism that
  98. every software project released, including those released quite recently,
  99. need changes. The most important consideration at this stage is to regulate
  100. and control the documentation and its changes.
  101.  
  102.   SCC is a decomposition process that offers a complete and precise
  103. description of what (line-by-line) changes have occurred between two source
  104. files. This results in faster development time, along with software that is
  105. far less likely to fail in use.
  106.  
  107. Page 3
  108.                           Can managers use SCC ?
  109.                           ----------------------
  110.   Using SCC creates an environment that is very time and cost effective.
  111. SCC allows changes to be made in a more maintainable, reliable and
  112. controllable way; that is, software control is fully documented, along with
  113. a full audit trail of what changes have occurred between software versions.
  114.  
  115.   The management of software changes at the programming (source) level
  116. (generally accepted as the most expensive and weakest link in software
  117. management) is one of the most difficult problems managers and programmers
  118. alike have.
  119.  
  120.   SCC greatly improves the suitability and appropriateness of software
  121. change documents; enhances clarity, readability, reliability and complete
  122. recoverability; allowing software changes to be a great deal easier to
  123. track and maintain.
  124.  
  125.                     Does SCC require a speceal editor ?
  126.                     -----------------------------------
  127.   No, all that's required is that the input source files to CSS be in
  128. (Ascii TEXT) format.
  129.  
  130.                       Does CSS Require a Data Base ?
  131.                       ------------------------------
  132.   No, SCC can either be integrated into a data base or stand alone, for
  133. most small projects a data base is not necessary, thus eliminating
  134. complexity and cost (KISS). All header file-id, code and documentation
  135. changes "between versions" are kept within the SCC Log itself.
  136.  
  137.                  Can I run SCC against existing versions ?
  138.                  -----------------------------------------
  139.   Yes, you can build new and complete SCC change logs from older existing
  140. (version to version) files, this will give a entire audit trail of any
  141. software changes between versions. 
  142.  
  143.                         What can SCC be used for ?
  144.                         --------------------------
  145.     o  Documenting
  146.     o  Software control
  147.     o  Software Debugging
  148.     o  version pre release (development) change control
  149.     o  Code walkthrough's
  150.     o  etc.
  151.  
  152.                          Using SCC for Documenting
  153.                          -------------------------
  154.   When SCC is run, the tracking (output) log file will then reflect (in
  155. context) what changes that have occurred between the two (input) source
  156. files, thus allowing the programmer and/or management to control, enhance
  157. and document software at this critical source level.
  158.  
  159.   SCC generates a software change (log) that closely tracks and records all
  160. changes consisting of a header, control change numbers and special symbols
  161. to reflect the operations of delete '-', insert '+', move ' ' etc.
  162.  
  163. Page 3
  164.                       Using SCC for Software control
  165.                       ------------------------------
  166.   The Manager/Programmer can visually see on one listing (the  CHANGE  Log)
  167. all changes and special tracking symbols that were necessary to build the
  168. later version from the earlier version, thus keeping an accurate control
  169. over all changes.
  170.  
  171.   SCC will also reveal all unintentional and possible unauthorized changes
  172. to source files, thus preventing future problems in the next released
  173. version.
  174.  
  175.   SCC helps the programmer and manager to make changes, "edit out" any
  176. tactical coding/design errors between two source files. This can be done by
  177. using a similar method such as the following:
  178.  
  179.   Initial Technical Design Review
  180.     o  revision of raw draft coding design
  181.     o  clarification of ambiguous design content
  182.     o  identification of coding gaps and inconsistencies
  183.     o  discovery of major/minor coding errors
  184.  
  185.   Coding Review
  186.     o  verification of content NOT already tested or debugged
  187.     o  incorporation of late technical coding changes
  188.     o  writing specs for changed docunentation
  189.  
  190.   Final Technical Design Review
  191.     o  refining the source code for usability
  192.     o  minor "edit" cleanup
  193.     o  careful configuration control and test proofing
  194.  
  195.   Field Maintenance of Released Software
  196.     o  discovery of unintentional coding errors
  197.     o  discovery of undocumented features
  198.     o  uncovering code that once worked, but now does not
  199.     o  SCC Log header information for release identification and control
  200.  
  201. Page 5
  202.                                 SCC summary
  203.                                 -----------
  204.  
  205.   SCC enables detailed verification of auditing accuracy, eliminates
  206. undetected programming errors and drastically reduces manual desk checking
  207. time.
  208.  
  209.   The manager/programmer knows exactly what the changes are between
  210. versions.
  211.   SCC accepts (ASCII TEXT) output from your favored editor.
  212.   SCC is a comprehensive utility designed to compare two files and generate
  213. various reports (log files) that display any or all change differences as
  214. they evolve.
  215.  
  216.   You can track any coding progress on software changes by viewing an SCC
  217. log against the previous and/or developing files.
  218.  
  219.   You can backtrack to any previous version to examine what changes created
  220. that release at that time.
  221.  
  222.   SCC change log report (version to version) can greatly help in debugging
  223. changes between versions (one works the other does not).
  224.  
  225.   You can build new and complete SCC change logs from older existing
  226. (version to version) files.
  227.  
  228.   The key benefits of SCC are:
  229.     o  lower project costs
  230.     o  controlled release management
  231.     o  structured walkthroughs
  232.     o  faster software coding thruput
  233.     o  higher software quality
  234.  
  235.      If you would like further infomation about this or the SCC registered
  236.      programs, please call Walter Erickson at (516) 981-8386
  237.  
  238.